\nThe CommandLineExecutor component let you define command line call using the command extension point.\nYou can call those commands with your own arguments like blobs or properties. The result is available\nin the ExecResult object.\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent", "descriptors": [ "org.nuxeo.ecm.platform.commandline.executor.service.EnvironmentDescriptor" ], "documentation": "\n Extension point to contribute environment configuration.\n\n Available options are:\n - name: comma-separated string attribute used as the environment parameters scope.\n It can be empty to set environment parameters common to all commands, equal to a command name to set parameters\n for that command only, or equal to a command line to set parameters common to all commands using that command line.\n You can associate multiple commands using a comma as separator.\n\n - workingDirectory: the Folder when command should be executed. Default is the system temporary folder.\n\n - parameters/parameter\n\n @author Thierry Delprat (td@nuxeo.com)\n\n CommandLine contribution\n example:\n\n \n \n some value \n \n \n\n",
"documentationHtml": "\nExtension point to contribute environment configuration.\n
\nAvailable options are:\n- name: comma-separated string attribute used as the environment parameters scope.\nIt can be empty to set environment parameters common to all commands, equal to a command name to set parameters\nfor that command only, or equal to a command line to set parameters common to all commands using that command line.\nYou can associate multiple commands using a comma as separator.\n
\n- workingDirectory: the Folder when command should be executed. Default is the system temporary folder.\n
\n- parameters/parameter\n
\nCommandLine contribution\nexample:\n
<environment name="aCommandName,aCommandLine">\n <parameters>\n <parameter name="SOME_VAR">some value</parameter>\n </parameters>\n </environment>\n\n \n commandName \n -any -parameters '%specific' %parameters #{blobOrPath} \n -any -parameters \"%specific\" %parameters \" #{blobOrPath} \n -any -parameters \n -any -specific -windows -parameters \n You need to install commandName. \n \n\n\n\n @author Thierry Delprat (td@nuxeo.com)\n \n",
"documentationHtml": "\nExtension point to contribute new commands.\n
\nAvailable options are:\n- name: string attribute used as the command identifier.\n
\n- enabled: boolean attribute, command is unavailable if false.\n
\n- commandLine: the command to execute.\n
\n- parameterString: the parameters to pass to the command. Parameters like #{parameter} represents a file. So you\ncan use either a path to a file or a blob. Parameters like %parameters are literals.\n
\n- winParameterString: Same as above but used in windows environments. For instance you have to use double quotes\nin windows instead of simple quote.\n
\n- winCommand: command to execute specifically for windows. Use commandLine is WinCommand is null;\n
\n@since 8.4\n- testParameterString: the parameters to pass to the CommandTester. The CommandTester will run the command with\nthese params\n
\n@since 8.4\n- winTestParameterString: same as above but used in windows environments.\n
\n- tester: name of the CommandTester. The CommandTester defined in commandTester extension point. Default is\nDefaultCommandTester, which looks if the command is available.\n
\n- readOutput: Boolean, default is true. If false, command output is never read.\n
\n- installationDirective: a String that is returned instead of the usual output when the command isn't available.\n
\nCommandLine contribution example:\n
<command enabled="true" name="myCommand">\n <commandLine>commandName</commandLine>\n <parameterString> -any -parameters '%specific' %parameters #{blobOrPath}</parameterString>\n <winParameterString> -any -parameters "%specific" %parameters " #{blobOrPath}</winParameterString>\n <testParameterString> -any -parameters</testParameterString>\n <winTestParameterString> -any -specific -windows -parameters</winTestParameterString>\n <installationDirective>You need to install commandName.</installationDirective>\n </command>\n\n \n \n\n\n @author Thierry Delprat (td@nuxeo.com)\n \n",
"documentationHtml": "\nExtension point to contribute new command testers.\nIt's a class that provides a way to test if a command is installed on the target server OS.\n
\nAvailable options are:\n-name: the name of the commandTester.\n
\n-class: the class\nimplementing CommandTester interface.\n
\nCommand tester contribution example:\n
<commandTester\n class="org.nuxeo.ecm.platform.commandline.executor.service.cmdtesters.DefaultCommandTester" name="DefaultCommandTester"/>\n\n \n \n some value \n \n \n \n \n \n commandName \n -any -parameters '%specific' %parameters #{blobOrPath} \n -any -parameters \"%specific\" %parameters \" #{blobOrPath} \n -any -parameters \n -any -specific -windows -parameters \n You need to install commandName. \n \n \n\n @author Thierry Delprat (td@nuxeo.com)\n \n \n \n \n\n @author Thierry Delprat (td@nuxeo.com)\n \nDefault environment parameters.
", "extensionPoint": "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent--environment", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.commandline.executor/org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib/Contributions/org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib--environment", "id": "org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib--environment", "registrationOrder": 0, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent", "name": "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent", "type": "service" }, "version": "2023.11.13", "xml": "\n\nSimple default tester that only checks for command existence in the system path.
", "extensionPoint": "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent--commandTester", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.commandline.executor/org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib/Contributions/org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib--commandTester", "id": "org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib--commandTester", "registrationOrder": 0, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent", "name": "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent", "type": "service" }, "version": "2023.11.13", "xml": "